Motion.TestAxis method

Runs a command test to check the drive response to the commanded value, such as commanded position, velocity, or torque. This method can only be used with the modeDirectVel, modeDirectPos, and modeDirectTor modes.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus TestAxis(
       int Index,
       double Amplitude
)

Public Function TestAxis(
       Index As Integer,
       Amplitude As Double
) As KsCommandStatus

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Amplitude

Type: double

The amplitude of the command in the test. The unit varies according to your control mode.

Control mode	Default unit	User unit (if the user changed the unit)
DirectPos	Count	User unit
DirectVel	Count per second	User unit per second
DirectTor	Percent (%)	Percent (%)

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

This method is designed for the Test response of the Tune page of Device configuration of KINGSTAR Configuration Tool. It can be used only with direct control modes. Use it with Api.Log to check whether the response of servo drives is correct.

Examples

N/A